Skip to content

fix: clarify audit scope in README - #18

Merged
devonartis merged 3 commits into
developfrom
fix/readme-audit-wording
Apr 13, 2026
Merged

fix: clarify audit scope in README#18
devonartis merged 3 commits into
developfrom
fix/readme-audit-wording

Conversation

@devonartis

Copy link
Copy Markdown
Owner

Summary

  • Rewording: "Every issue / renew / revoke / delegate / release event is audited" → clarifies these are credential lifecycle events, not agent activity at the resource server

Test plan

  • CI gates green

…ivity

The old wording could be read as "the broker logs everything the agent
does." It only logs credential lifecycle events (issue, renew, revoke,
delegate, release, auth failures, scope violations) — not what the
agent does with the token at the resource server.
@github-actions

github-actions Bot commented Apr 13, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Snapshot Warnings

⚠️: No snapshots were found for the head SHA 5d92b55.
Ensure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice.

Scanned Files

None

Restructured for newcomers who scan, not read:
- Quick Start: one path (Docker Hub), 5 commands, no inline essays
- "Why this matters" comparison table replaces prose bullets
- "How it works" simplified flow + numbered steps
- Every section ends with "where to go next" links
- Documentation table uses "I want to..." framing
- API table adds "Who uses it" column
- Config collapsed to essentials + link to operator guide
- TLS/mTLS/nginx/cosign moved to docs (not README)
@devonartis
devonartis merged commit 92528d8 into develop Apr 13, 2026
20 checks passed
devonartis added a commit that referenced this pull request Apr 13, 2026
- PR #18: README restructured as a landing page — scannable Quick Start,
  comparison table, intent-based docs navigation, simplified architecture.
  469 lines removed, 169 added. Audit wording clarified.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant